package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.NewsGroupAddDTO;
import org.jsola.hr.dto.NewsGroupUpdateDTO;
import org.jsola.hr.query.NewsGroupQuery;
import org.jsola.hr.vo.NewsGroupListVO;
import org.jsola.hr.vo.NewsGroupVO;

import java.util.List;

/**
 * 官网新闻类型分组
 *
 * @author zhr
 */
@Api(tags = "hr-官网新闻类型分组")
public interface INewsGroupControllerAPI {

    /**
     * 新增官网新闻类型分组
     * @param newsGroupAddDTO 官网新闻类型分组新增实体
     * @return 官网新闻类型分组展示对象
     */
    @ApiOperation(value = "新增官网新闻类型分组")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "newsGroupAddDTO", dataType = "NewsGroupAddDTO", value = "新增官网新闻类型分组", paramType = "body")
    })
    Result<NewsGroupVO> save(NewsGroupAddDTO newsGroupAddDTO);


    /**
     * 修改官网新闻类型分组
     * @param newsGroupUpdateDTO 官网新闻类型分组
     * @return 更新数量
     */
    @ApiOperation(value = "修改官网新闻类型分组")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "newsGroupUpdateDTO", dataType = "NewsGroupUpdateDTO", value = "修改官网新闻类型分组", paramType = "body")
    })
    Result<Integer> update(NewsGroupUpdateDTO newsGroupUpdateDTO);




    /**
     * 删除单个官网新闻类型分组，彻底删除
     * @param newsGroupId 官网新闻类型分组id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个官网新闻类型分组，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "newsGroupId", dataType = "String", value = "官网新闻类型分组id", paramType = "path")
    })
    Result<Integer> delete(String newsGroupId);


    /**
     * 批量删除官网新闻类型分组，彻底删除
     * @param newsGroupIds 官网新闻类型分组id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除官网新闻类型分组，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "newsGroupIds", dataType = "String[]", value = "官网新闻类型分组id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] newsGroupIds);


    /**
     * 根据官网新闻类型分组id查询官网新闻类型分组详情
     * @param newsGroupId 官网新闻类型分组id
     * @return 官网新闻类型分组详情
     */
    @ApiOperation(value="根据官网新闻类型分组id查询官网新闻类型分组详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "newsGroupId", dataType = "String", value = "官网新闻类型分组id", paramType = "path")
    })
    Result<NewsGroupVO> findById(String newsGroupId);


    /**
     * 查询官网新闻类型分组
     * @param newsGroupQuery 官网新闻类型分组查询参数
     * @return page
     */
    @ApiOperation(value="查询官网新闻类型分组")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "newsGroupQuery", dataType = "NewsGroupQuery", value = "官网新闻类型分组查询参数", paramType = "query")
    })
    Result<List<NewsGroupListVO>> listAll(NewsGroupQuery newsGroupQuery);


     /**
     * 分页查询官网新闻类型分组
     * @param newsGroupQuery 官网新闻类型分组查询参数
     * @return page
     */
    @ApiOperation(value="分页查询官网新闻类型分组")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "newsGroupQuery", dataType = "NewsGroupQuery", value = "官网新闻类型分组查询参数", paramType = "query")
    })
    Result<Page<NewsGroupListVO>> page(NewsGroupQuery newsGroupQuery);


}

